/*
 * Copyright (c) Joachim Ansorg, mail@ansorg-it.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.ansorgit.plugins.bash.editor.inspections;

import com.ansorgit.plugins.bash.lang.psi.util.BashPsiElementFactory;
import com.intellij.openapi.project.Project;
import com.intellij.psi.PsiComment;
import com.intellij.psi.PsiElement;
import com.intellij.psi.util.PsiTreeUtil;
import org.jetbrains.annotations.Nullable;

/**
 * Helper class to work with Bash suppression comments.
 *
 * @author jansorg
 */
public class SupressionUtil {
    private static final String SUPPRESSION_PREFIX = "@IgnoreInspection";

    @Nullable
    public static PsiComment findSuppressionComment(PsiElement anchor) {
        return PsiTreeUtil.getChildOfType(anchor, PsiComment.class);
    }

    public static boolean isSuppressionComment(PsiComment suppressionComment, String inspectionId) {
        return suppressionComment != null && suppressionComment.getText().trim().endsWith(SUPPRESSION_PREFIX + " " + inspectionId);
    }

    public static PsiComment createSuppressionComment(Project project, String id) {
        return BashPsiElementFactory.createComment(project, SUPPRESSION_PREFIX + " " + id);
    }
}
